Skip to content

chore: deprecate SearchApiWebSearch + update docs#11611

Merged
julian-risch merged 1 commit into
mainfrom
chore/deprecate-searchapi-websearch
Jun 15, 2026
Merged

chore: deprecate SearchApiWebSearch + update docs#11611
julian-risch merged 1 commit into
mainfrom
chore/deprecate-searchapi-websearch

Conversation

@julian-risch

@julian-risch julian-risch commented Jun 12, 2026

Copy link
Copy Markdown
Member

Related Issues

Proposed Changes:

  • deprecate SearchApiWebSearch with a FutureWarning pointing users to the new searchapi-haystack package (feat: add searchapi integration (moved from Haystack core) haystack-core-integrations#3437)
  • update the docs page (current and version-2.30) to show the new package name, install command, and import path
  • fix the docstring usage example, which wrongly referenced SERPERDEV_API_KEY instead of SEARCHAPI_API_KEY
  • make the live-API integration test assertions robust: when SearchApi returns an answer box or knowledge graph, documents and links (organic results only) differ in length, so the old len(documents) == len(links) == 10 assertion fails on main today (same fix as for SerperDev in chore: deprecate SerperDevWebSearch + update docs #11577)

How did you test it?

  • hatch run test:integration test/components/websearch/test_searchapi.py with a real SEARCHAPI_API_KEY locally (we don't have one set in the CI in haystack. only in haystack-core-integrations): 2 passed (failed before the assertion fix)

Notes for the reviewer

Checklist

  • I have read the contributors guidelines and the code of conduct.
  • I have updated the related issue with new insights and changes.
  • I have added unit tests and updated the docstrings.
  • I've used one of the conventional commit types for my PR title: fix:, feat:, build:, chore:, ci:, docs:, style:, refactor:, perf:, test: and added ! in case the PR includes breaking changes.
  • I have documented my code.
  • I have added a release note file, following the contributors guidelines.
  • I have run pre-commit hooks and fixed any issue.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jun 12, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
haystack-docs Ready Ready Preview, Comment Jun 15, 2026 9:52am

Request Review

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  haystack/components/websearch
  searchapi.py
Project Total  

This report was generated by python-coverage-comment-action

@julian-risch julian-risch marked this pull request as ready for review June 15, 2026 09:57
@julian-risch julian-risch requested a review from a team as a code owner June 15, 2026 09:57
@julian-risch julian-risch requested review from davidsbatista and removed request for a team June 15, 2026 09:57
@claude

claude Bot commented Jun 15, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@davidsbatista davidsbatista left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@julian-risch julian-risch merged commit b7f75b0 into main Jun 15, 2026
30 checks passed
@julian-risch julian-risch deleted the chore/deprecate-searchapi-websearch branch June 15, 2026 11:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

topic:tests type:documentation Improvements on the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants